| Package | hl7.cda.us.ccdar2dot2 |
| Type | StructureDefinition |
| Id | Id |
| FHIR Version | R4 |
| Source | http://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda-2.2/StructureDefinition-2.16.840.1.113883.10.20.22.1.10.html |
| Url | http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.10 |
| Version | 2.2 |
| Status | active |
| Date | 2022-05-13T15:50:12+00:00 |
| Name | UnstructuredDocument |
| Title | Unstructured Document |
| Experimental | False |
| Realm | us |
| Authority | hl7 |
| Description | An Unstructured Document (UD) document type can (1) include unstructured content, such as a graphic, directly in a text element with a mediaType attribute, or (2) reference a single document file, such as a word-processing document using a text/reference element. For guidance on how to handle multiple files, on the selection of media types for this IG, and on the identification of external files, see the examples that follow the constraints below. IHEs XDS-SD (Cross-Transaction Specifications and Content Specifications, Scanned Documents Module) profile addresses a similar, more restricted use case, specifically for scanned documents or documents electronically created from existing text sources, and limits content to PDF-A or text. This Unstructured Documents template is applicable not only for scanned documents in non-PDF formats, but also for clinical documents produced through word processing applications, etc. For conformance with both specifications, implementers need to ensure that their documents at a minimum conform with the SHALL constraints from either specification. |
| Type | ClinicalDocument |
| Kind | resource |
No resources found
| StructureDefinition | |
http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1  | US Realm Header |
Note: links and images are rebased to the (stated) source
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ClinicalDocument | 1..1 | USRealmHeader | ||
  Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:primary | I | 1..1 | II | 1198-32944: When asserting this templateId, all C-CDA 2.1 section and entry templates that had a previous version in C-CDA R1.1 **SHALL** include both the C-CDA 2.1 templateId and the C-CDA R1.1 templateId root without an extension. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-32944). |
  root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.1.10 | |
  extension | 1..1 | string | Required Pattern: 2015-08-01 | |
| recordTarget | 1..* | RecordTarget | The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element | |
 patientRole | 1..1 | PatientRole | ||
| id | 1..* | II | ||
| custodian | 1..1 | Custodian | The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document. There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. | |
| assignedCustodian | 1..1 | AssignedCustodian | ||
| representedCustodianOrganization | 1..1 | CustodianOrganization | ||
| component | 1..1 | Component2 | ||
| nonXMLBody | 1..1 | NonXMLBody | An Unstructured Document must include a nonXMLBody component with a single text element. The text element can reference an external file using a reference element, or include unstructured content directly with a mediaType attribute. The nonXMLBody/text element also has a "compression" attribute that can be used to indicate that the unstructured content was compressed before being Base64Encoded. At a minimum, a compression value of "DF" for the deflate compression algorithm (RFC 1951 [URL:http://www.ietf.org/rfc/rfc1951.txt]) must be supported although it is not required that content be compressed. | |
| text | I | 1..1 | ED | 1198-7624: If the text element does not contain a reference element with a value attribute, then it **SHALL** contain exactly one [1..1] @representation="B64" and exactly one [1..1] @mediaType (CONF:1198-7624). 1198-7623: The value of @mediaType, if present, **SHALL** be drawn from the value set 2.16.840.1.113883.11.20.7.1 SupportedFileFormats STATIC 2010-05-12 (CONF:1198-7623). |
| Documentation for this format | ||||
FHIR{
"resourceType" : "StructureDefinition",
"id" : "2.16.840.1.113883.10.20.22.1.10",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Minimum and Maximum # of times the the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/R4/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument\">ClinicalDocument</a><a name=\"ClinicalDocument\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.1.html\">USRealmHeader</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck13.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_slice.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Slice Definition\" class=\"hierarchy\"/> <a style=\"font-style: italic\" href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.templateId\">Slices for templateId</a><a name=\"ClinicalDocument.templateId\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-style: italic\"/><span style=\"opacity: 0.5; font-style: italic\">0</span><span style=\"opacity: 0.5; font-style: italic\">..</span><span style=\"opacity: 0.5; font-style: italic\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5; font-style: italic\" href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-II.html\">II</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold; font-style: italic\">Slice: </span><span style=\"font-style: italic\">Unordered, Open by value:root, value:extension</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck125.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end_slicer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_slice_item.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Slice Item\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.templateId:primary\" title=\"Slice primary\">templateId:primary</a><a name=\"ClinicalDocument.templateId\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"padding-left: 3px; padding-right: 3px; color: black; null\" title=\"This element has or is affected by some invariants (1198-32944)\">I</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-II.html\">II</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">1198-32944: </span>When asserting this templateId, all C-CDA 2.1 section and entry templates that had a previous version in C-CDA R1.1 **SHALL** include both the C-CDA 2.1 templateId and the C-CDA R1.1 templateId root without an extension. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-32944).</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1250.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_slice.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.templateId:primary.root\">root</a><a name=\"ClinicalDocument.templateId.root\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">Required Pattern: </span><span style=\"color: darkgreen\">2.16.840.1.113883.10.20.22.1.10</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1240.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end_slice.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_extension_simple.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Simple Extension\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.templateId:primary.extension\">extension</a><a name=\"ClinicalDocument.templateId.extension\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">Required Pattern: </span><span style=\"color: darkgreen\">2015-08-01</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.recordTarget\">recordTarget</a><a name=\"ClinicalDocument.recordTarget\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..*</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-RecordTarget.html\">RecordTarget</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element</span><br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck101.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.recordTarget.patientRole\">patientRole</a><a name=\"ClinicalDocument.recordTarget.patientRole\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-PatientRole.html\">PatientRole</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.recordTarget.patientRole.id\">id</a><a name=\"ClinicalDocument.recordTarget.patientRole.id\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..*</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-II.html\">II</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.custodian\">custodian</a><a name=\"ClinicalDocument.custodian\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-Custodian.html\">Custodian</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document.\n\nThere is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party.</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck101.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.custodian.assignedCustodian\">assignedCustodian</a><a name=\"ClinicalDocument.custodian.assignedCustodian\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AssignedCustodian.html\">AssignedCustodian</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization\">representedCustodianOrganization</a><a name=\"ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-CustodianOrganization.html\">CustodianOrganization</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.component\">component</a><a name=\"ClinicalDocument.component\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-Component2.html\">Component2</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck001.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.component.nonXMLBody\">nonXMLBody</a><a name=\"ClinicalDocument.component.nonXMLBody\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-NonXMLBody.html\">NonXMLBody</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">An Unstructured Document must include a nonXMLBody component with a single text element. The text element can reference an external file using a reference element, or include unstructured content directly with a mediaType attribute. The nonXMLBody/text element also has a "compression" attribute that can be used to indicate that the unstructured content was compressed before being Base64Encoded. At a minimum, a compression value of "DF" for the deflate compression algorithm (RFC 1951 [URL:http://www.ietf.org/rfc/rfc1951.txt]) must be supported although it is not required that content be compressed.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.10-definitions.html#ClinicalDocument.component.nonXMLBody.text\">text</a><a name=\"ClinicalDocument.component.nonXMLBody.text\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"padding-left: 3px; padding-right: 3px; color: black; null\" title=\"This element has or is affected by some invariants (1198-7624, 1198-7623)\">I</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-ED.html\">ED</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">1198-7624: </span>If the text element does not contain a reference element with a value attribute, then it **SHALL** contain exactly one [1..1] @representation="B64" and exactly one [1..1] @mediaType (CONF:1198-7624).<br/><span style=\"font-weight:bold\">1198-7623: </span>The value of @mediaType, if present, **SHALL** be drawn from the value set 2.16.840.1.113883.11.20.7.1 SupportedFileFormats STATIC 2010-05-12 (CONF:1198-7623).</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/R4/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.10",
"identifier" : [
{
"value" : "urn:hl7ii:2.16.840.1.113883.10.20.22.1.10:2015-08-01"
}
],
"version" : "2.2",
"name" : "UnstructuredDocument",
"title" : "Unstructured Document",
"status" : "active",
"date" : "2022-05-13T15:50:12+00:00",
"publisher" : "Health Level Seven",
"contact" : [
{
"name" : "HL7 International - Structured Documents",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description" : "An Unstructured Document (UD) document type can (1) include unstructured content, such as a graphic, directly in a text element with a mediaType attribute, or (2) reference a single document file, such as a word-processing document using a text/reference element.\nFor guidance on how to handle multiple files, on the selection of media types for this IG, and on the identification of external files, see the examples that follow the constraints below.\nIHEs XDS-SD (Cross-Transaction Specifications and Content Specifications, Scanned Documents Module) profile addresses a similar, more restricted use case, specifically for scanned documents or documents electronically created from existing text sources, and limits content to PDF-A or text. This Unstructured Documents template is applicable not only for scanned documents in non-PDF formats, but also for clinical documents produced through word processing applications, etc. \nFor conformance with both specifications, implementers need to ensure that their documents at a minimum conform with the SHALL constraints from either specification.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"fhirVersion" : "4.0.1",
"kind" : "resource",
"abstract" : false,
"type" : "ClinicalDocument",
"baseDefinition" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "ClinicalDocument",
"path" : "ClinicalDocument",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false
},
{
"id" : "ClinicalDocument.classCode",
"path" : "ClinicalDocument.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "DOCCLIN",
"fixedCode" : "DOCCLIN",
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActClass"
}
},
{
"id" : "ClinicalDocument.moodCode",
"path" : "ClinicalDocument.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.moodCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "EVN",
"fixedCode" : "EVN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActMood"
}
},
{
"id" : "ClinicalDocument.realmCode",
"path" : "ClinicalDocument.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"requirements" : "SHALL contain exactly one [1..1] realmCode=\"US\" (CONF:1198-16791).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
],
"patternString" : "US"
},
{
"id" : "ClinicalDocument.typeId",
"path" : "ClinicalDocument.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"requirements" : "SHALL contain exactly one [1..1] typeId (CONF:1198-5361).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.typeId",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.typeId.nullFlavor",
"path" : "ClinicalDocument.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.typeId.displayable",
"path" : "ClinicalDocument.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "ClinicalDocument.typeId.root",
"path" : "ClinicalDocument.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"requirements" : "This typeId SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.1.3\" (CONF:1198-5250).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"patternString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.typeId.extension",
"path" : "ClinicalDocument.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"requirements" : "This typeId SHALL contain exactly one [1..1] @extension=\"POCD_HD000040\" (CONF:1198-5251).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"patternString" : "POCD_HD000040"
},
{
"id" : "ClinicalDocument.templateId",
"path" : "ClinicalDocument.templateId",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "root"
},
{
"type" : "value",
"path" : "extension"
}
],
"rules" : "open"
},
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.templateId:primary",
"path" : "ClinicalDocument.templateId",
"sliceName" : "primary",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"requirements" : "SHALL contain exactly one [1..1] templateId (CONF:1198-7710) such that it",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "1198-32944",
"severity" : "error",
"human" : "When asserting this templateId, all C-CDA 2.1 section and entry templates that had a previous version in C-CDA R1.1 **SHALL** include both the C-CDA 2.1 templateId and the C-CDA R1.1 templateId root without an extension. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-32944)."
}
]
},
{
"id" : "ClinicalDocument.templateId:primary.nullFlavor",
"path" : "ClinicalDocument.templateId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.templateId:primary.assigningAuthorityName",
"path" : "ClinicalDocument.templateId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.templateId:primary.displayable",
"path" : "ClinicalDocument.templateId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "ClinicalDocument.templateId:primary.root",
"path" : "ClinicalDocument.templateId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"requirements" : "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.10.20.22.1.10\" (CONF:1198-10054).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"patternString" : "2.16.840.1.113883.10.20.22.1.10"
},
{
"id" : "ClinicalDocument.templateId:primary.extension",
"path" : "ClinicalDocument.templateId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"requirements" : "SHALL contain exactly one [1..1] @extension=\"2015-08-01\" (CONF:1198-32522).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"patternString" : "2015-08-01"
},
{
"id" : "ClinicalDocument.id",
"path" : "ClinicalDocument.id",
"requirements" : "SHALL contain exactly one [1..1] id (CONF:1198-5363).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "1198-9991",
"severity" : "warning",
"human" : "This id **SHALL** be a globally unique identifier for the document (CONF:1198-9991).",
"source" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1"
}
]
},
{
"id" : "ClinicalDocument.code",
"path" : "ClinicalDocument.code",
"requirements" : "SHALL contain exactly one [1..1] code (CONF:1198-5253).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"constraint" : [
{
"key" : "1198-9992",
"severity" : "error",
"human" : "This code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:1198-9992).",
"source" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1"
},
{
"key" : "1198-32948",
"severity" : "error",
"human" : "This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:1198-32948).",
"source" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-DocumentType"
}
},
{
"id" : "ClinicalDocument.title",
"path" : "ClinicalDocument.title",
"label" : "The title can either be a locally defined name or the displayName corresponding to clinicalDocument/code",
"short" : "The title can either be a locally defined name or the displayName corresponding to clinicalDocument/code",
"requirements" : "SHALL contain exactly one [1..1] title (CONF:1198-5254).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.title",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.effectiveTime",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-timeformat",
"valueCode" : "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
}
],
"path" : "ClinicalDocument.effectiveTime",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"requirements" : "SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:1198-5256).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.effectiveTime",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.4"
]
}
],
"constraint" : [
{
"key" : "81-10127",
"severity" : "error",
"human" : "**SHALL** be precise to the day (CONF:81-10127).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-10128",
"severity" : "warning",
"human" : "**SHOULD** be precise to the minute (CONF:81-10128).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-10129",
"severity" : "warning",
"human" : "**MAY** be precise to the second (CONF:81-10129).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-10130",
"severity" : "warning",
"human" : "If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.confidentialityCode",
"path" : "ClinicalDocument.confidentialityCode",
"requirements" : "SHALL contain exactly one [1..1] confidentialityCode, which SHOULD be selected from ValueSet HL7 BasicConfidentialityKind urn:oid:2.16.840.1.113883.1.11.16926 DYNAMIC (CONF:1198-5259).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.confidentialityCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926"
}
},
{
"id" : "ClinicalDocument.languageCode",
"path" : "ClinicalDocument.languageCode",
"requirements" : "SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:1198-5372).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.languageCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.11526"
}
},
{
"id" : "ClinicalDocument.setId",
"path" : "ClinicalDocument.setId",
"requirements" : "MAY contain zero or one [0..1] setId (CONF:1198-5261).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.setId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "1198-6380",
"severity" : "error",
"human" : "If setId is present versionNumber **SHALL** be present (CONF:1198-6380).",
"source" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1"
}
]
},
{
"id" : "ClinicalDocument.versionNumber",
"path" : "ClinicalDocument.versionNumber",
"requirements" : "MAY contain zero or one [0..1] versionNumber (CONF:1198-5264).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.versionNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/INT"
}
],
"constraint" : [
{
"key" : "1198-6387",
"severity" : "error",
"human" : "If versionNumber is present setId **SHALL** be present (CONF:1198-6387).",
"source" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1"
}
]
},
{
"id" : "ClinicalDocument.copyTime",
"path" : "ClinicalDocument.copyTime",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.copyTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget",
"path" : "ClinicalDocument.recordTarget",
"short" : "The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element",
"requirements" : "SHALL contain at least one [1..*] recordTarget (CONF:1198-31089).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.recordTarget",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/RecordTarget"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.nullFlavor",
"path" : "ClinicalDocument.recordTarget.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RecordTarget.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.typeCode",
"path" : "ClinicalDocument.recordTarget.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "RecordTarget.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "RCT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "ClinicalDocument.recordTarget.contextControlCode",
"path" : "ClinicalDocument.recordTarget.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "RecordTarget.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
}
},
{
"id" : "ClinicalDocument.recordTarget.realmCode",
"path" : "ClinicalDocument.recordTarget.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RecordTarget.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.typeId",
"path" : "ClinicalDocument.recordTarget.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RecordTarget.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.templateId",
"path" : "ClinicalDocument.recordTarget.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RecordTarget.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole",
"path" : "ClinicalDocument.recordTarget.patientRole",
"requirements" : "Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:1198-31090).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RecordTarget.patientRole",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PatientRole"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "PatientRole.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "PAT",
"fixedCode" : "PAT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PatientRole.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.id",
"path" : "ClinicalDocument.recordTarget.patientRole.id",
"requirements" : "This patientRole SHALL contain at least one [1..*] id (CONF:1198-31091).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "PatientRole.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "identifiedBy"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PatientRole.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.addr",
"path" : "ClinicalDocument.recordTarget.patientRole.addr",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"requirements" : "This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5271).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "PatientRole.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AD",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.2"
]
}
],
"constraint" : [
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom",
"path" : "ClinicalDocument.recordTarget.patientRole.telecom",
"requirements" : "This patientRole SHALL contain at least one [1..*] telecom (CONF:1198-5280).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "PatientRole.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.telecom.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom.value",
"path" : "ClinicalDocument.recordTarget.patientRole.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueString" : "SXPR-TS"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom.use",
"path" : "ClinicalDocument.recordTarget.patientRole.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"requirements" : "Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-5375).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient",
"path" : "ClinicalDocument.recordTarget.patientRole.patient",
"requirements" : "This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-5283).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PatientRole.patient",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Patient"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "PSN",
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.determinerCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.determinerCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.id",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.id",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.name",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.name",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"requirements" : "This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:1198-5284).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Patient.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PN",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.1"
]
}
],
"constraint" : [
{
"key" : "81-7278",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7278).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "desc"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcDesc",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode",
"requirements" : "This patient SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:1198-6394).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.administrativeGenderCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.1"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthTime",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthTime",
"requirements" : "This patient SHALL contain exactly one [1..1] birthTime (CONF:1198-5298).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.birthTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
}
],
"constraint" : [
{
"key" : "1198-5299",
"severity" : "error",
"human" : "**SHALL** be precise to year (CONF:1198-5299).",
"source" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1"
},
{
"key" : "1198-5300",
"severity" : "warning",
"human" : "**SHOULD** be precise to day (CONF:1198-5300).",
"source" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1"
},
{
"key" : "1198-32418",
"severity" : "warning",
"human" : "**MAY** be precise to the minute (CONF:1198-32418).\nFor cases where information about newborn's time of birth needs to be captured.",
"source" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "deceasedInd"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcDeceasedInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "deceasedTime"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcDeceasedTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "multipleBirthInd"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcMultipleBirthInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "multipleBirthOrderNumber"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcMultipleBirthOrderNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/INT-POS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode",
"requirements" : "This patient SHOULD contain zero or one [0..1] maritalStatusCode, which SHALL be selected from ValueSet Marital Status urn:oid:2.16.840.1.113883.1.11.12212 DYNAMIC (CONF:1198-5303).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.maritalStatusCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode",
"requirements" : "This patient MAY contain zero or one [0..1] religiousAffiliationCode, which SHALL be selected from ValueSet Religious Affiliation urn:oid:2.16.840.1.113883.1.11.19185 DYNAMIC (CONF:1198-5317).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.religiousAffiliationCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.raceCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.raceCode",
"requirements" : "This patient SHALL contain exactly one [1..1] raceCode, which SHALL be selected from ValueSet Race Category Excluding Nulls urn:oid:2.16.840.1.113883.3.2074.1.1.3 DYNAMIC (CONF:1198-5322).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.raceCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.2074.1.1.3"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "raceCode"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode",
"requirements" : "This patient MAY contain zero or more [0..*] sdtc:raceCode, which SHALL be selected from ValueSet Race Value Set urn:oid:2.16.840.1.113883.1.11.14914 DYNAMIC (CONF:1198-7263).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.sdtcRaceCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode",
"requirements" : "This patient SHALL contain exactly one [1..1] ethnicGroupCode, which SHALL be selected from ValueSet Ethnicity urn:oid:2.16.840.1.114222.4.11.837 DYNAMIC (CONF:1198-5323).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.ethnicGroupCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.837"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "ethnicGroupCode"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode",
"requirements" : "This patient MAY contain zero or more [0..*] sdtc:ethnicGroupCode, which SHALL be selected from ValueSet Detailed Ethnicity urn:oid:2.16.840.1.114222.4.11.877 DYNAMIC (CONF:1198-32901).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.sdtcEthnicGroupCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.877"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian",
"requirements" : "This patient MAY contain zero or more [0..*] guardian (CONF:1198-5325).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.guardian",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Guardian"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Guardian.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "GUARD",
"fixedCode" : "GUARD",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAgent"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.id",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.id",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "identifiedBy"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.code",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.code",
"requirements" : "The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-5326).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Guardian.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.addr",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.addr",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"requirements" : "The guardian, if present, SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5359).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AD",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.2"
]
}
],
"constraint" : [
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom",
"requirements" : "The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:1198-5382).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueString" : "SXPR-TS"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"requirements" : "The telecom, if present, SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7993).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson",
"requirements" : "The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:1198-5385).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Guardian.guardianPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "PSN",
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.determinerCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"requirements" : "This guardianPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5386).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PN",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.1.1"
]
}
],
"constraint" : [
{
"key" : "81-9371",
"severity" : "error",
"human" : "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-9372",
"severity" : "error",
"human" : "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "asPatientRelationship"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Guardian.guardianOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace",
"requirements" : "This patient MAY contain zero or one [0..1] birthplace (CONF:1198-5395).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.birthplace",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Birthplace"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Birthplace.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "BIRTHPL",
"fixedCode" : "BIRTHPL",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassPassive"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Birthplace.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place",
"requirements" : "The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:1198-5396).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Birthplace.place",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Place"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Place.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "PLC",
"fixedCode" : "PLC",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassPlace"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Place.determinerCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Place.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Place.name",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/EN"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr",
"requirements" : "This place SHALL contain exactly one [1..1] addr (CONF:1198-5397).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Place.addr",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AD"
}
],
"constraint" : [
{
"key" : "1198-5402",
"severity" : "warning",
"human" : "If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet StateValueSet 2.16.840.1.113883.3.88.12.80.1 *DYNAMIC* (CONF:1198-5402).",
"source" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1"
},
{
"key" : "1198-5403",
"severity" : "warning",
"human" : "If country is US, this addr **MAY** contain zero or one [0..1] postalCode, which **SHALL** be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 *DYNAMIC* (CONF:1198-5403).",
"source" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.isNotOrdered",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.isNotOrdered",
"representation" : [
"xmlAttr"
],
"label" : "Is Not Ordered",
"definition" : "A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.isNotOrdered",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.use",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "A set of codes advising a system or user which address in a set of like addresses to select for a given purpose.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter",
"definition" : "Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.delimiter",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.delimiter.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "DEL"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country",
"definition" : "Country",
"requirements" : "This addr SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:1198-5404).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.country",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.country.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "CNT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state",
"definition" : "A sub-unit of a country with limited sovereignty in a federally organized country.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.state",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.state.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "STA"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county",
"definition" : "A sub-unit of a state or province. (49 of the United States of America use the term \"county;\" Louisiana uses the term \"parish\".)",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.county",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.county.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "CPA"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city",
"definition" : "The name of the city, town, village, or other community or delivery center",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.city",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.city.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "CTY"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode",
"definition" : "A postal code designating a region defined by the postal service.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.postalCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.postalCode.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "ZIP"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine",
"definition" : "Street address line",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.streetAddressLine",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.streetAddressLine.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "SAL"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber",
"definition" : "The number of a building, house or lot alongside the street. Also known as \"primary street number\". This does not number the street but rather the building.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.houseNumber",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.houseNumber.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "BNR"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric",
"definition" : "The numeric portion of a building number",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.houseNumberNumeric",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.houseNumberNumeric.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "BNN"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction",
"definition" : "Direction (e.g., N, S, W, E)",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.direction",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.direction.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "DIR"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName",
"definition" : "Name of a roadway or artery recognized by a municipality (including street type and direction)",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.streetName",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.streetName.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "STR"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase",
"definition" : "The base name of a roadway or artery recognized by a municipality (excluding street type and direction)",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.streetNameBase",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.streetNameBase.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "STB"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType",
"definition" : "The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.streetNameType",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.streetNameType.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "STTYP"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator",
"definition" : "This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., \"3rd floor, Appt. 342\"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch \"t.o.\" means \"opposite to\" for house boats located across the street facing houses).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.additionalLocator",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.additionalLocator.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "ADL"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID",
"definition" : "The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.unitID",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.unitID.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "UNID"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType",
"definition" : "Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.unitType",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.unitType.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "UNIT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf",
"definition" : "The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.careOf",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.careOf.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "CAR"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract",
"definition" : "A geographic sub-unit delineated for demographic purposes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.censusTract",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.censusTract.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "CEN"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine",
"definition" : "A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.deliveryAddressLine",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.deliveryAddressLine.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "DAL"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType",
"definition" : "Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.deliveryInstallationType",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.deliveryInstallationType.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "DINST"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea",
"definition" : "The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.deliveryInstallationArea",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.deliveryInstallationArea.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "DINSTA"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier",
"definition" : "A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.deliveryInstallationQualifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.deliveryInstallationQualifier.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "DINSTQ"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode",
"definition" : "Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.deliveryMode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.deliveryMode.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "DMOD"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier",
"definition" : "Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.deliveryModeIdentifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.deliveryModeIdentifier.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "DMODID"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix",
"definition" : "Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.buildingNumberSuffix",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.buildingNumberSuffix.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "BNS"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox",
"definition" : "A numbered box located in a post station.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.postBox",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.postBox.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "POB"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct",
"definition" : "A subsection of a municipality",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.precinct",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ADXP"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.precinct.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "PRE"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.other",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.other",
"representation" : [
"xmlText"
],
"definition" : "Textual representation of (part of) the address",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.other",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod[x]",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueString" : "SXPR-TS"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod[x]",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.useablePeriod[x]",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication",
"requirements" : "This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:1198-5406).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.languageCommunication",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/LanguageCommunication"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "LanguageCommunication.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode",
"requirements" : "The languageCommunication, if present, SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:1198-5407).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.languageCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.11526"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode",
"requirements" : "The languageCommunication, if present, MAY contain zero or one [0..1] modeCode, which SHALL be selected from ValueSet LanguageAbilityMode urn:oid:2.16.840.1.113883.1.11.12249 DYNAMIC (CONF:1198-5409).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.modeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12249"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode",
"requirements" : "The languageCommunication, if present, SHOULD contain zero or one [0..1] proficiencyLevelCode, which SHALL be selected from ValueSet LanguageAbilityProficiency urn:oid:2.16.840.1.113883.1.11.12199 DYNAMIC (CONF:1198-9965).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.proficiencyLevelCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12199"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd",
"requirements" : "The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:1198-5414).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.preferenceInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization",
"requirements" : "This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:1198-5416).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PatientRole.providerOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Organization.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "ORG",
"fixedCode" : "ORG",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Organization.determinerCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id",
"requirements" : "The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:1198-5417).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Organization.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"requirements" : "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:1198-16820).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"patternString" : "2.16.840.1.113883.4.6"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.name",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.name",
"requirements" : "The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:1198-5419).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Organization.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ON"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom",
"requirements" : "The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:1198-5420).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Organization.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueString" : "SXPR-TS"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"requirements" : "Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7994).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.addr",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.addr",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"requirements" : "The providerOrganization, if present, SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5422).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Organization.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AD",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.2"
]
}
],
"constraint" : [
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.standardIndustryClassCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.asOrganizationPartOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf"
}
]
},
{
"id" : "ClinicalDocument.author",
"path" : "ClinicalDocument.author",
"short" : "The author element represents the creator of the clinical document. The author may be a device or a person.",
"requirements" : "SHALL contain at least one [1..*] author (CONF:1198-5444).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.author",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Author"
}
]
},
{
"id" : "ClinicalDocument.author.nullFlavor",
"path" : "ClinicalDocument.author.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Author.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.author.typeCode",
"path" : "ClinicalDocument.author.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Author.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "AUT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "ClinicalDocument.author.contextControlCode",
"path" : "ClinicalDocument.author.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Author.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
}
},
{
"id" : "ClinicalDocument.author.realmCode",
"path" : "ClinicalDocument.author.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Author.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.author.typeId",
"path" : "ClinicalDocument.author.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Author.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.author.templateId",
"path" : "ClinicalDocument.author.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Author.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.author.functionCode",
"path" : "ClinicalDocument.author.functionCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Author.functionCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.author.time",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-timeformat",
"valueCode" : "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
}
],
"path" : "ClinicalDocument.author.time",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"requirements" : "Such authors SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:1198-5445).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Author.time",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.4"
]
}
],
"constraint" : [
{
"key" : "81-10127",
"severity" : "error",
"human" : "**SHALL** be precise to the day (CONF:81-10127).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-10128",
"severity" : "warning",
"human" : "**SHOULD** be precise to the minute (CONF:81-10128).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-10129",
"severity" : "warning",
"human" : "**MAY** be precise to the second (CONF:81-10129).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-10130",
"severity" : "warning",
"human" : "If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.author.assignedAuthor",
"path" : "ClinicalDocument.author.assignedAuthor",
"requirements" : "Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-5448).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Author.assignedAuthor",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor"
}
],
"constraint" : [
{
"key" : "1198-16790",
"severity" : "error",
"human" : "There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:1198-16790).",
"source" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.classCode",
"path" : "ClinicalDocument.author.assignedAuthor.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "ASSIGNED",
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.templateId",
"path" : "ClinicalDocument.author.assignedAuthor.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedAuthor.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id",
"path" : "ClinicalDocument.author.assignedAuthor.id",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "root"
}
],
"rules" : "open"
},
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedAuthor.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "1198-5449",
"human" : "If this assignedAuthor is not an assignedPerson, this assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-5449)."
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:id1",
"path" : "ClinicalDocument.author.assignedAuthor.id",
"sliceName" : "id1",
"requirements" : "This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:1198-32882) such that it",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:id1.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.id.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"short" : "If id with @root=\"2.16.840.1.113883.4.6\" National Provider Identifier is unknown then",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"requirements" : "MAY contain zero or one [0..1] @nullFlavor=\"UNK\" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:1198-32883).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"patternCode" : "UNK",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:id1.assigningAuthorityName",
"path" : "ClinicalDocument.author.assignedAuthor.id.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:id1.displayable",
"path" : "ClinicalDocument.author.assignedAuthor.id.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:id1.root",
"path" : "ClinicalDocument.author.assignedAuthor.id.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"requirements" : "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:1198-32884).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"patternString" : "2.16.840.1.113883.4.6"
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:id1.extension",
"path" : "ClinicalDocument.author.assignedAuthor.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"requirements" : "SHOULD contain zero or one [0..1] @extension (CONF:1198-32885).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "identifiedBy"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedAuthor.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code",
"path" : "ClinicalDocument.author.assignedAuthor.code",
"short" : "Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code.",
"requirements" : "This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:1198-16787).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleCode"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.code.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.code",
"path" : "ClinicalDocument.author.assignedAuthor.code.code",
"representation" : [
"xmlAttr"
],
"label" : "Code",
"definition" : "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"requirements" : "The code, if present, SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-16788).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.codeSystem",
"path" : "ClinicalDocument.author.assignedAuthor.code.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystem",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.codeSystemName",
"path" : "ClinicalDocument.author.assignedAuthor.code.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.codeSystemVersion",
"path" : "ClinicalDocument.author.assignedAuthor.code.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.displayName",
"path" : "ClinicalDocument.author.assignedAuthor.code.displayName",
"representation" : [
"xmlAttr"
],
"label" : "Display Name",
"definition" : "A name or title for the code, under which the sending system shows the code value to its users.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.sdtcValueSet",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "valueSet"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.code.sdtcValueSet",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.valueSet",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.sdtcValueSetVersion",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "valueSetVersion"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.code.sdtcValueSetVersion",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.sdtcValueSetVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.originalText",
"path" : "ClinicalDocument.author.assignedAuthor.code.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.qualifier",
"path" : "ClinicalDocument.author.assignedAuthor.code.qualifier",
"label" : "Qualifier",
"definition" : "Specifies additional codes that increase the specificity of the the primary code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.qualifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CR"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.translation",
"path" : "ClinicalDocument.author.assignedAuthor.code.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CD"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.addr",
"path" : "ClinicalDocument.author.assignedAuthor.addr",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"requirements" : "This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5452).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedAuthor.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AD",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.2"
]
}
],
"constraint" : [
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.author.assignedAuthor.telecom",
"path" : "ClinicalDocument.author.assignedAuthor.telecom",
"requirements" : "This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:1198-5428).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedAuthor.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.telecom.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.telecom.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.telecom.value",
"path" : "ClinicalDocument.author.assignedAuthor.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueString" : "SXPR-TS"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.telecom.use",
"path" : "ClinicalDocument.author.assignedAuthor.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"requirements" : "Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7995).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson",
"requirements" : "This assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:1198-5430).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.assignedPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.classCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "PSN",
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.determinerCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.templateId",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.name",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.name",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"requirements" : "The assignedPerson, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-16789).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PN",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.1.1"
]
}
],
"constraint" : [
{
"key" : "81-9371",
"severity" : "error",
"human" : "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-9372",
"severity" : "error",
"human" : "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "asPatientRelationship"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice",
"requirements" : "This assignedAuthor SHOULD contain zero or one [0..1] assignedAuthoringDevice (CONF:1198-16783).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.assignedAuthoringDevice",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AuthoringDevice"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuthoringDevice.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "DEV",
"fixedCode" : "DEV",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassDevice"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuthoringDevice.determinerCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.templateId",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuthoringDevice.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuthoringDevice.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityCode"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName",
"requirements" : "The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:1198-16784).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuthoringDevice.manufacturerModelName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/SC"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName",
"requirements" : "The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:1198-16785).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuthoringDevice.softwareName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/SC"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuthoringDevice.asMaintainedEntity",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/MaintainedEntity"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.representedOrganization",
"path" : "ClinicalDocument.author.assignedAuthor.representedOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.representedOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer",
"path" : "ClinicalDocument.dataEnterer",
"short" : "The dataEnterer element represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content found within the header or body of a document, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system.",
"requirements" : "MAY contain zero or one [0..1] dataEnterer (CONF:1198-5441).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.dataEnterer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/DataEnterer"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DataEnterer.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.dataEnterer.typeCode",
"path" : "ClinicalDocument.dataEnterer.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DataEnterer.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "ENT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "ClinicalDocument.dataEnterer.contextControlCode",
"path" : "ClinicalDocument.dataEnterer.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DataEnterer.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
}
},
{
"id" : "ClinicalDocument.dataEnterer.realmCode",
"path" : "ClinicalDocument.dataEnterer.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DataEnterer.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.typeId",
"path" : "ClinicalDocument.dataEnterer.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DataEnterer.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.templateId",
"path" : "ClinicalDocument.dataEnterer.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DataEnterer.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.time",
"path" : "ClinicalDocument.dataEnterer.time",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DataEnterer.time",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity",
"path" : "ClinicalDocument.dataEnterer.assignedEntity",
"requirements" : "The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-5442).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DataEnterer.assignedEntity",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.classCode",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "ASSIGNED",
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.templateId",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.id",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.id",
"requirements" : "This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-5443).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.id.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.id.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.id.assigningAuthorityName",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.id.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.id.displayable",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.id.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.id.root",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.id.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"requirements" : "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:1198-16821).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"patternString" : "2.16.840.1.113883.4.6"
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.id.extension",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "identifiedBy"
}
],
"path" : "ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.code",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.code",
"requirements" : "This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-32173).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
}
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.addr",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.addr",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"requirements" : "This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5460).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AD",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.2"
]
}
],
"constraint" : [
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.telecom",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.telecom",
"requirements" : "This assignedEntity SHALL contain at least one [1..*] telecom (CONF:1198-5466).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.value",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueString" : "SXPR-TS"
}
],
"path" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.use",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"requirements" : "Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7996).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson",
"requirements" : "This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:1198-5469).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.assignedPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "PSN",
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.determinerCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.templateId",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"requirements" : "This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5470).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PN",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.1.1"
]
}
],
"constraint" : [
{
"key" : "81-9371",
"severity" : "error",
"human" : "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-9372",
"severity" : "error",
"human" : "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "asPatientRelationship"
}
],
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.representedOrganization",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.representedOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.representedOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.informant",
"path" : "ClinicalDocument.informant",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "relatedEntity"
}
],
"rules" : "open"
},
"short" : "The informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.informant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Informant"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1",
"path" : "ClinicalDocument.informant",
"sliceName" : "informant1",
"short" : "The informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.",
"requirements" : "MAY contain zero or more [0..*] informant (CONF:1198-8001) such that it",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.informant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Informant"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.nullFlavor",
"path" : "ClinicalDocument.informant.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.informant:informant1.typeCode",
"path" : "ClinicalDocument.informant.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "INF",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "ClinicalDocument.informant:informant1.contextControlCode",
"path" : "ClinicalDocument.informant.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
}
},
{
"id" : "ClinicalDocument.informant:informant1.realmCode",
"path" : "ClinicalDocument.informant.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Informant.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.typeId",
"path" : "ClinicalDocument.informant.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.templateId",
"path" : "ClinicalDocument.informant.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Informant.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity",
"path" : "ClinicalDocument.informant.assignedEntity",
"requirements" : "SHALL contain exactly one [1..1] assignedEntity (CONF:1198-8002).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Informant.assignedEntity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.classCode",
"path" : "ClinicalDocument.informant.assignedEntity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "ASSIGNED",
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.templateId",
"path" : "ClinicalDocument.informant.assignedEntity.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.id",
"path" : "ClinicalDocument.informant.assignedEntity.id",
"requirements" : "This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-9945).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "1198-9946",
"severity" : "warning",
"human" : "If assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root =\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:1198-9946)."
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.sdtcIdentifiedBy",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "identifiedBy"
}
],
"path" : "ClinicalDocument.informant.assignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.code",
"path" : "ClinicalDocument.informant.assignedEntity.code",
"requirements" : "This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-32174).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
}
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.addr",
"path" : "ClinicalDocument.informant.assignedEntity.addr",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"requirements" : "This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-8220).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AD",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.2"
]
}
],
"constraint" : [
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.telecom",
"path" : "ClinicalDocument.informant.assignedEntity.telecom",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.assignedPerson",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson",
"requirements" : "This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:1198-8221).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.assignedPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.classCode",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "PSN",
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.determinerCode",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.determinerCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.templateId",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.name",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"requirements" : "This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-8222).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PN",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.1.1"
]
}
],
"constraint" : [
{
"key" : "81-9371",
"severity" : "error",
"human" : "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-9372",
"severity" : "error",
"human" : "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "asPatientRelationship"
}
],
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.assignedEntity.representedOrganization",
"path" : "ClinicalDocument.informant.assignedEntity.representedOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.representedOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.informant:informant1.relatedEntity",
"path" : "ClinicalDocument.informant.relatedEntity",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.relatedEntity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity"
}
]
},
{
"id" : "ClinicalDocument.informant:informant2",
"path" : "ClinicalDocument.informant",
"sliceName" : "informant2",
"requirements" : "MAY contain zero or more [0..*] informant (CONF:1198-31355) such that it",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.informant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Informant"
}
]
},
{
"id" : "ClinicalDocument.informant:informant2.nullFlavor",
"path" : "ClinicalDocument.informant.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.informant:informant2.typeCode",
"path" : "ClinicalDocument.informant.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "INF",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "ClinicalDocument.informant:informant2.contextControlCode",
"path" : "ClinicalDocument.informant.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
}
},
{
"id" : "ClinicalDocument.informant:informant2.realmCode",
"path" : "ClinicalDocument.informant.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Informant.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.informant:informant2.typeId",
"path" : "ClinicalDocument.informant.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informant:informant2.templateId",
"path" : "ClinicalDocument.informant.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Informant.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informant:informant2.assignedEntity",
"path" : "ClinicalDocument.informant.assignedEntity",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.assignedEntity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
}
]
},
{
"id" : "ClinicalDocument.informant:informant2.relatedEntity",
"path" : "ClinicalDocument.informant.relatedEntity",
"requirements" : "SHALL contain exactly one [1..1] relatedEntity (CONF:1198-31356).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Informant.relatedEntity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity"
}
]
},
{
"id" : "ClinicalDocument.custodian",
"path" : "ClinicalDocument.custodian",
"short" : "The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document.\n\nThere is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party.",
"requirements" : "SHALL contain exactly one [1..1] custodian (CONF:1198-31096).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.custodian",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Custodian"
}
]
},
{
"id" : "ClinicalDocument.custodian.nullFlavor",
"path" : "ClinicalDocument.custodian.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Custodian.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.custodian.typeCode",
"path" : "ClinicalDocument.custodian.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Custodian.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "ENT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "ClinicalDocument.custodian.realmCode",
"path" : "ClinicalDocument.custodian.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Custodian.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.custodian.typeId",
"path" : "ClinicalDocument.custodian.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Custodian.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.custodian.templateId",
"path" : "ClinicalDocument.custodian.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Custodian.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian",
"path" : "ClinicalDocument.custodian.assignedCustodian",
"requirements" : "This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-31097).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Custodian.assignedCustodian",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedCustodian"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.classCode",
"path" : "ClinicalDocument.custodian.assignedCustodian.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedCustodian.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "ASSIGNED",
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.templateId",
"path" : "ClinicalDocument.custodian.assignedCustodian.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedCustodian.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization",
"requirements" : "This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:1198-31098).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedCustodian.representedCustodianOrganization",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CustodianOrganization"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "CustodianOrganization.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "ORG",
"fixedCode" : "ORG",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization"
}
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "CustodianOrganization.determinerCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.templateId",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CustodianOrganization.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id",
"requirements" : "This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:1198-5522).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "CustodianOrganization.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.nullFlavor",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.assigningAuthorityName",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.displayable",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.root",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"requirements" : "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:1198-16822).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"patternString" : "2.16.840.1.113883.4.6"
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name",
"requirements" : "This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:1198-5524).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CustodianOrganization.name",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ON"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom",
"requirements" : "This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:1198-5525).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CustodianOrganization.telecom",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.nullFlavor",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueString" : "SXPR-TS"
}
],
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"requirements" : "This telecom SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7998).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"requirements" : "This representedCustodianOrganization SHALL contain exactly one [1..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5559).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CustodianOrganization.addr",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AD",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.2"
]
}
],
"constraint" : [
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.informationRecipient",
"path" : "ClinicalDocument.informationRecipient",
"short" : "The informationRecipient element records the intended recipient of the information at the time the document was created. In cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to the scoping organization for that chart.",
"requirements" : "MAY contain zero or more [0..*] informationRecipient (CONF:1198-5565).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.informationRecipient",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/InformationRecipient"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.nullFlavor",
"path" : "ClinicalDocument.informationRecipient.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InformationRecipient.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.informationRecipient.typeCode",
"path" : "ClinicalDocument.informationRecipient.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "InformationRecipient.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "PRCP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "ClinicalDocument.informationRecipient.realmCode",
"path" : "ClinicalDocument.informationRecipient.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InformationRecipient.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.typeId",
"path" : "ClinicalDocument.informationRecipient.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InformationRecipient.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.templateId",
"path" : "ClinicalDocument.informationRecipient.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InformationRecipient.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient",
"requirements" : "The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-5566).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "InformationRecipient.intendedRecipient",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IntendedRecipient"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.classCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "IntendedRecipient.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "ASSIGNED"
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.templateId",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "IntendedRecipient.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.id",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.id",
"requirements" : "This intendedRecipient MAY contain zero or more [0..*] id (CONF:1198-32399).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "IntendedRecipient.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "identifiedBy"
}
],
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "IntendedRecipient.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.addr",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.addr",
"min" : 0,
"max" : "*",
"base" : {
"path" : "IntendedRecipient.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AD"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.telecom",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.telecom",
"min" : 0,
"max" : "*",
"base" : {
"path" : "IntendedRecipient.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient",
"requirements" : "This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:1198-5567).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IntendedRecipient.informationRecipient",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "PSN",
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.determinerCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.templateId",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"requirements" : "The informationRecipient, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5568).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/PN",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.1.1"
]
}
],
"constraint" : [
{
"key" : "81-9371",
"severity" : "error",
"human" : "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-9372",
"severity" : "error",
"human" : "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "asPatientRelationship"
}
],
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization",
"requirements" : "This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:1198-5577).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IntendedRecipient.receivedOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Organization.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "ORG",
"fixedCode" : "ORG",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization"
}
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Organization.determinerCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.templateId",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name",
"requirements" : "The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:1198-5578).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Organization.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ON"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AD"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.standardIndustryClassCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS"
}
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.asOrganizationPartOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator",
"path" : "ClinicalDocument.legalAuthenticator",
"short" : "The legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. A clinical document that does not contain this element has not been legally authenticated.\n\nThe act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. Based on local practice, clinical documents may be released before legal authentication. \n\nAll clinical documents have the potential for legal authentication, given the appropriate credentials.\n\nLocal policies MAY choose to delegate the function of legal authentication to a device or system that generates the clinical document. In these cases, the legal authenticator is a person accepting responsibility for the document, not the generating device or system.\n\nNote that the legal authenticator, if present, must be a person.",
"requirements" : "SHOULD contain zero or one [0..1] legalAuthenticator (CONF:1198-5579).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.legalAuthenticator",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/LegalAuthenticator"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.typeCode",
"path" : "ClinicalDocument.legalAuthenticator.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "LA",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.contextControlCode",
"path" : "ClinicalDocument.legalAuthenticator.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.realmCode",
"path" : "ClinicalDocument.legalAuthenticator.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "LegalAuthenticator.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.typeId",
"path" : "ClinicalDocument.legalAuthenticator.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.templateId",
"path" : "ClinicalDocument.legalAuthenticator.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "LegalAuthenticator.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.time",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-timeformat",
"valueCode" : "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
}
],
"path" : "ClinicalDocument.legalAuthenticator.time",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"requirements" : "The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:1198-5580).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.time",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS",
"profile" : [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.4"
]
}
],
"constraint" : [
{
"key" : "81-10127",
"severity" : "error",
"human" : "**SHALL** be precise to the day (CONF:81-10127).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-10128",
"severity" : "warning",
"human" : "**SHOULD** be precise to the minute (CONF:81-10128).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-10129",
"severity" : "warning",
"human" : "**MAY** be precise to the second (CONF:81-10129).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
},
{
"key" : "81-10130",
"severity" : "warning",
"human" : "If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130).",
"source" : "http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"
}
],
"isModifier" : false
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode",
"requirements" : "The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:1198-5583).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.signatureCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.code",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.code",
"representation" : [
"xmlAttr"
],
"label" : "Code",
"definition" : "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"requirements" : "This signatureCode SHALL contain exactly one [1..1] @code=\"S\" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:1198-5584).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"patternString" : "S"
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.codeSystem",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystem",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.displayName",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.displayName",
"representation" : [
"xmlAttr"
],
"label" : "Display Name",
"definition" : "A name or title for the code, under which the sending system shows the code value to its users.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.sdtcValueSet",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "valueSet"
}
],
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.sdtcValueSet",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.valueSet",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.sdtcValueSetVersion",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "valueSetVersion"
}
],
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.sdtcValueSetVersion",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.sdtcValueSetVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.originalText",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.qualifier",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.qualifier",
"label" : "Qualifier",
"definition" : "Specifies additional codes that increase the specificity of the the primary code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.qualifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CR"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.translation",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CD"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.sdtcSignatureText",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "signatureText"
}
],
"path" : "ClinicalDocument.legalAuthenticator.sdtcSignatureText",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.sdtcSignatureText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity",
"requirements" : "The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-5585).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.assignedEntity",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.classCode",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "ASSIGNED",
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.templateId",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.id",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id",
"requirements" : "This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-5586).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.assigningAuthorityName",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.displayable",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.root",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"requirements" : "Such ids MAY contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:1198-16823).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"patternString" : "2.16.840.1.113883.4.6"
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.extension",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefin rmer",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Performer1"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Performer1.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.typeCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.typeCode",
"representation" : [
"xmlAttr"
],
"requirements" : "The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:1198-14840).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Performer1.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "DOC",
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19601"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.realmCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Performer1.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.typeId",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Performer1.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.templateId",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Performer1.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode",
"requirements" : "The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-16818).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Performer1.functionCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code",
"representation" : [
"xmlAttr"
],
"label" : "Code",
"definition" : "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"requirements" : "The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:1198-32889).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystem",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.displayName",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.displayName",
"representation" : [
"xmlAttr"
],
"label" : "Display Name",
"definition" : "A name or title for the code, under which the sending system shows the code value to its users.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSet",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "valueSet"
}
],
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSet",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.valueSet",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSetVersion",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "valueSetVersion"
}
],
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSetVersion",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.sdtcValueSetVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier",
"label" : "Qualifier",
"definition" : "Specifies additional codes that increase the specificity of the the primary code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.qualifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CR"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CD"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.time",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.time",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Performer1.time",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity",
"requirements" : "The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-14841).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Performer1.assignedEntity",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "ASSIGNED",
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.templateId",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id",
"requirements" : "This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-14846).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.assigningAuthorityName",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.displayable",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.root",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"requirements" : "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:1198-14847).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"patternString" : "2.16.840.1.113883.4.6"
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "identifiedBy"
}
],
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code",
"requirements" : "This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-14842).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AD"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.assignedPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.representedOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.relatedDocument",
"path" : "ClinicalDocument.relatedDocument",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.relatedDocument",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/RelatedDocument"
}
]
},
{
"id" : "ClinicalDocument.authorization",
"path" : "ClinicalDocument.authorization",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "consent"
}
],
"rules" : "open"
},
"short" : "The authorization element represents information about the patient?s consent.\n\nThe type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of ?Privacy Consent?.\n\nThe authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.authorization",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Authorization"
}
]
},
{
"id" : "ClinicalDocument.authorization:authorization1",
"path" : "ClinicalDocument.authorization",
"sliceName" : "authorization1",
"requirements" : "MAY contain zero or more [0..*] authorization (CONF:1198-16792) such that it",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.authorization",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Authorization"
}
]
},
{
"id" : "ClinicalDocument.authorization:authorization1.nullFlavor",
"path" : "ClinicalDocument.authorization.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Authorization.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.authorization:authorization1.typeCode",
"path" : "ClinicalDocument.authorization.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Authorization.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "AUT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "ClinicalDocument.authorization:authorization1.realmCode",
"path" : "ClinicalDocument.authorization.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Authorization.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.authorization:authorization1.typeId",
"path" : "ClinicalDocument.authorization.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Authorization.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.authorization:authorization1.templateId",
"path" : "ClinicalDocument.authorization.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Authorization.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.authorization:authorization1.consent",
"path" : "ClinicalDocument.authorization.consent",
"requirements" : "SHALL contain exactly one [1..1] consent (CONF:1198-16793).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Authorization.consent",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Consent"
}
]
},
{
"id" : "ClinicalDocument.authorization:authorization1.consent.classCode",
"path" : "ClinicalDocument.authorization.consent.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "CONS",
"fixedCode" : "CONS",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActClass"
}
},
{
"id" : "ClinicalDocument.authorization:authorization1.consent.moodCode",
"path" : "ClinicalDocument.authorization.consent.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.moodCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "EVN",
"fixedCode" : "EVN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActMood"
}
},
{
"id" : "ClinicalDocument.authorization:authorization1.consent.templateId",
"path" : "ClinicalDocument.authorization.consent.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.authorization:authorization1.consent.id",
"path" : "ClinicalDocument.authorization.consent.id",
"requirements" : "This consent MAY contain zero or more [0..*] id (CONF:1198-16794).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.authorization:authorization1.consent.code",
"path" : "ClinicalDocument.authorization.consent.code",
"label" : "The type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code.",
"short" : "The type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code.",
"requirements" : "This consent MAY contain zero or one [0..1] code (CONF:1198-16795).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActCode"
}
},
{
"id" : "ClinicalDocument.authorization:authorization1.consent.statusCode",
"path" : "ClinicalDocument.authorization.consent.statusCode",
"requirements" : "This consent SHALL contain exactly one [1..1] statusCode (CONF:1198-16797).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.statusCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActStatus"
}
},
{
"id" : "ClinicalDocument.authorization:authorization1.consent.statusCode.code",
"path" : "ClinicalDocument.authorization.consent.statusCode.code",
"representation" : [
"xmlAttr"
],
"requirements" : "This statusCode SHALL contain exactly one [1..1] @code=\"completed\" Completed (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-16798).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.statusCode.code",
"min" : 1,
"max" : "1"
},
"defaultValueCode" : "completed",
"fixedString" : "completed"
},
{
"id" : "ClinicalDocument.componentOf",
"path" : "ClinicalDocument.componentOf",
"short" : "The encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section.",
"requirements" : "MAY contain zero or one [0..1] componentOf (CONF:1198-9955).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.componentOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ComponentOf"
}
]
},
{
"id" : "ClinicalDocument.componentOf.nullFlavor",
"path" : "ClinicalDocument.componentOf.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ComponentOf.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.componentOf.typeCode",
"path" : "ClinicalDocument.componentOf.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ComponentOf.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "AUT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "ClinicalDocument.componentOf.realmCode",
"path" : "ClinicalDocument.componentOf.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ComponentOf.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.componentOf.typeId",
"path" : "ClinicalDocument.componentOf.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ComponentOf.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.componentOf.templateId",
"path" : "ClinicalDocument.componentOf.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ComponentOf.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter",
"path" : "ClinicalDocument.componentOf.encompassingEncounter",
"requirements" : "The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-9956).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ComponentOf.encompassingEncounter",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/EncompassingEncounter"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.classCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "ENC",
"fixedCode" : "ENC",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActClass"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.moodCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.moodCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "EVN",
"fixedCode" : "EVN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActMood"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.templateId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EncompassingEncounter.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.id",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.id",
"requirements" : "This encompassingEncounter SHALL contain at least one [1..*] id (CONF:1198-9959).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "EncompassingEncounter.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.code",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.code",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.effectiveTime",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.effectiveTime",
"requirements" : "This encompassingEncounter SHALL contain exactly one [1..1] effectiveTime (CONF:1198-9958).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.effectiveTime",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "admissionReferralSourceCode"
}
],
"path" : "ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.sdtcAdmissionReferralSourceCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.dischargeDispositionCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EncounterDischargeDisposition"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.responsibleParty",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Element"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.responsibleParty.typeCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "RESP",
"fixedCode" : "RESP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.responsibleParty.assignedEntity",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EncompassingEncounter.encounterParticipant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.location",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Element"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.location.typeCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "LOC",
"fixedCode" : "LOC",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.location.healthCareFacility",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility"
}
]
},
{
"id" : "ClinicalDocument.component",
"path" : "ClinicalDocument.component",
"requirements" : "SHALL contain exactly one [1..1] component (CONF:1198-31085).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.component",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Component2"
}
]
},
{
"id" : "ClinicalDocument.component.nullFlavor",
"path" : "ClinicalDocument.component.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Component2.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id" : "ClinicalDocument.component.typeCode",
"path" : "ClinicalDocument.component.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Component2.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "AUT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
}
},
{
"id" : "ClinicalDocument.component.contextConductionInd",
"path" : "ClinicalDocument.component.contextConductionInd",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Component2.contextConductionInd",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"defaultValueBoolean" : true
},
{
"id" : "ClinicalDocument.component.realmCode",
"path" : "ClinicalDocument.component.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Component2.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.component.typeId",
"path" : "ClinicalDocument.component.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Component2.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.component.templateId",
"path" : "ClinicalDocument.component.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Component2.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody",
"path" : "ClinicalDocument.component.nonXMLBody",
"short" : "An Unstructured Document must include a nonXMLBody component with a single text element. The text element can reference an external file using a reference element, or include unstructured content directly with a mediaType attribute. The nonXMLBody/text element also has a \"compression\" attribute that can be used to indicate that the unstructured content was compressed before being Base64Encoded. At a minimum, a compression value of \"DF\" for the deflate compression algorithm (RFC 1951 [URL:http://www.ietf.org/rfc/rfc1951.txt]) must be supported although it is not required that content be compressed.",
"requirements" : "This component SHALL contain exactly one [1..1] nonXMLBody (CONF:1198-31086).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Component2.nonXMLBody",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/NonXMLBody"
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.classCode",
"path" : "ClinicalDocument.component.nonXMLBody.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "NonXMLBody.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "DOCBODY",
"fixedCode" : "DOCBODY",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActClassOrganizer"
}
},
{
"id" : "ClinicalDocument.component.nonXMLBody.moodCode",
"path" : "ClinicalDocument.component.nonXMLBody.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "NonXMLBody.moodCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "EVN",
"fixedCode" : "EVN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActMood"
}
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text",
"path" : "ClinicalDocument.component.nonXMLBody.text",
"requirements" : "This nonXMLBody SHALL contain exactly one [1..1] text (CONF:1198-31087).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NonXMLBody.text",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
],
"constraint" : [
{
"key" : "1198-7624",
"severity" : "error",
"human" : "If the text element does not contain a reference element with a value attribute, then it **SHALL** contain exactly one [1..1] @representation=\"B64\" and exactly one [1..1] @mediaType (CONF:1198-7624)."
},
{
"key" : "1198-7623",
"severity" : "error",
"human" : "The value of @mediaType, if present, **SHALL** be drawn from the value set 2.16.840.1.113883.11.20.7.1 SupportedFileFormats STATIC 2010-05-12 (CONF:1198-7623)."
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.confidentialityCode",
"path" : "ClinicalDocument.component.nonXMLBody.confidentialityCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NonXMLBody.confidentialityCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.languageCode",
"path" : "ClinicalDocument.component.nonXMLBody.languageCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NonXMLBody.languageCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-HumanLanguage"
}
},
{
"id" : "ClinicalDocument.component.structuredBody",
"path" : "ClinicalDocument.component.structuredBody",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Component2.structuredBody",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/StructuredBody"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "ClinicalDocument",
"path" : "ClinicalDocument"
},
{
"id" : "ClinicalDocument.templateId",
"path" : "ClinicalDocument.templateId",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "root"
},
{
"type" : "value",
"path" : "extension"
}
],
"rules" : "open"
}
},
{
"id" : "ClinicalDocument.templateId:primary",
"path" : "ClinicalDocument.templateId",
"sliceName" : "primary",
"requirements" : "SHALL contain exactly one [1..1] templateId (CONF:1198-7710) such that it",
"min" : 1,
"max" : "1",
"constraint" : [
{
"key" : "1198-32944",
"severity" : "error",
"human" : "When asserting this templateId, all C-CDA 2.1 section and entry templates that had a previous version in C-CDA R1.1 **SHALL** include both the C-CDA 2.1 templateId and the C-CDA R1.1 templateId root without an extension. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-32944)."
}
]
},
{
"id" : "ClinicalDocument.templateId:primary.root",
"path" : "ClinicalDocument.templateId.root",
"requirements" : "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.10.20.22.1.10\" (CONF:1198-10054).",
"min" : 1,
"max" : "1",
"patternString" : "2.16.840.1.113883.10.20.22.1.10"
},
{
"id" : "ClinicalDocument.templateId:primary.extension",
"path" : "ClinicalDocument.templateId.extension",
"requirements" : "SHALL contain exactly one [1..1] @extension=\"2015-08-01\" (CONF:1198-32522).",
"min" : 1,
"max" : "1",
"patternString" : "2015-08-01"
},
{
"id" : "ClinicalDocument.recordTarget",
"path" : "ClinicalDocument.recordTarget",
"requirements" : "SHALL contain at least one [1..*] recordTarget (CONF:1198-31089).",
"min" : 1,
"max" : "*"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole",
"path" : "ClinicalDocument.recordTarget.patientRole",
"requirements" : "Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:1198-31090).",
"min" : 1,
"max" : "1"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.id",
"path" : "ClinicalDocument.recordTarget.patientRole.id",
"requirements" : "This patientRole SHALL contain at least one [1..*] id (CONF:1198-31091).",
"min" : 1,
"max" : "*"
},
{
"id" : "ClinicalDocument.custodian",
"path" : "ClinicalDocument.custodian",
"requirements" : "SHALL contain exactly one [1..1] custodian (CONF:1198-31096).",
"min" : 1,
"max" : "1"
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian",
"path" : "ClinicalDocument.custodian.assignedCustodian",
"requirements" : "This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-31097).",
"min" : 1,
"max" : "1"
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization",
"requirements" : "This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:1198-31098).",
"min" : 1,
"max" : "1"
},
{
"id" : "ClinicalDocument.component",
"path" : "ClinicalDocument.component",
"requirements" : "SHALL contain exactly one [1..1] component (CONF:1198-31085).",
"min" : 1,
"max" : "1"
},
{
"id" : "ClinicalDocument.component.nonXMLBody",
"path" : "ClinicalDocument.component.nonXMLBody",
"short" : "An Unstructured Document must include a nonXMLBody component with a single text element. The text element can reference an external file using a reference element, or include unstructured content directly with a mediaType attribute. The nonXMLBody/text element also has a \"compression\" attribute that can be used to indicate that the unstructured content was compressed before being Base64Encoded. At a minimum, a compression value of \"DF\" for the deflate compression algorithm (RFC 1951 [URL:http://www.ietf.org/rfc/rfc1951.txt]) must be supported although it is not required that content be compressed.",
"requirements" : "This component SHALL contain exactly one [1..1] nonXMLBody (CONF:1198-31086).",
"min" : 1,
"max" : "1"
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text",
"path" : "ClinicalDocument.component.nonXMLBody.text",
"requirements" : "This nonXMLBody SHALL contain exactly one [1..1] text (CONF:1198-31087).",
"min" : 1,
"max" : "1",
"constraint" : [
{
"key" : "1198-7624",
"severity" : "error",
"human" : "If the text element does not contain a reference element with a value attribute, then it **SHALL** contain exactly one [1..1] @representation=\"B64\" and exactly one [1..1] @mediaType (CONF:1198-7624)."
},
{
"key" : "1198-7623",
"severity" : "error",
"human" : "The value of @mediaType, if present, **SHALL** be drawn from the value set 2.16.840.1.113883.11.20.7.1 SupportedFileFormats STATIC 2010-05-12 (CONF:1198-7623)."
}
]
}
]
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.